Skip to content

Adds capability for the feed command, to specify index #501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ottpeter wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Adds capability for the feed command, to specify index #501

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7e02adb
feat(index): adds placeholder for unit tests
ottpeter May 23, 2024
689b2bb
test: adds unit test for feed write
ottpeter May 23, 2024
5a420a8
feat: adds optional index parameter for feed command
ottpeter May 23, 2024
75ebc7d
docs: changes description for index option
ottpeter May 23, 2024
1b6319a
fix: removes unnecessary act variable, and adds index
ottpeter May 23, 2024
7a2e32e
fix: adds index to print as well
ottpeter May 23, 2024
d65c3aa
fix: changes bee-js version, and fixes some bugs related to feed index
ottpeter May 23, 2024
abfc371
test: adds unit test for feed update as well (with ref)
ottpeter May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions src/command/feed/feed-command.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ export class FeedCommand extends RootCommand {
@Option({ key: 'password', alias: 'P', description: 'Password for the wallet' })
public password!: string

@Option({ key: 'index', description: 'Index for the feed to write to, or read from', required: false })
Copy link
Copy Markdown

@aranyia aranyia May 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it could simply say "Feed index to write to or read from"?

Copy link
Copy Markdown
Author

@ottpeter ottpeter May 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. I'll make this change.


public act!: boolean
protected async updateFeedAndPrint(chunkReference: string): Promise<string> {
const wallet = await this.getWallet()
const topic = this.topic || this.bee.makeFeedTopic(this.topicString)
Expand Down Expand Up @@ -79,7 +82,7 @@ export class FeedCommand extends RootCommand {
return identities[this.identity] || identities[await pickIdentity(this.commandConfig, this.console)]
}

private async writeFeed(wallet: Wallet, topic: string, chunkReference: string): Promise<FeedInfo> {
private async writeFeed(wallet: Wallet, topic: string, chunkReference: string, index?: number): Promise<FeedInfo> {
const spinner = createSpinner('Writing feed...')

if (this.verbosity !== VerbosityLevel.Quiet && !this.curl) {
Expand All @@ -88,7 +91,14 @@ export class FeedCommand extends RootCommand {

try {
const writer = this.bee.makeFeedWriter('sequence', topic, wallet.getPrivateKey())
const reference = await writer.upload(this.stamp, chunkReference as Reference)
let reference: Reference
if (index === undefined) {
// Index was not specified
reference = await writer.upload(this.stamp, chunkReference as Reference)
} else {
// Index was specified
reference = await writer.upload(this.stamp, chunkReference as Reference, { index })
}
const { reference: manifest } = await this.bee.createFeedManifest(
this.stamp,
'sequence',
Expand Down
2 changes: 1 addition & 1 deletion src/command/feed/update.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { FeedCommand } from './feed-command'
export class Update extends FeedCommand implements LeafCommand {
public readonly name = 'update'

public readonly description = 'Update feed'
public readonly description = 'Update feed (with reference)'

@Option({ key: 'reference', alias: 'r', description: 'The new reference', required: true })
public reference!: string
Expand Down
2 changes: 1 addition & 1 deletion src/command/feed/upload.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { FeedCommand } from './feed-command'
export class Upload extends FeedCommand implements LeafCommand {
public readonly name = 'upload'

public readonly description = 'Upload to a feed'
public readonly description = 'Upload to a feed (file or folder)'

public feedManifest?: string

Expand Down
85 changes: 85 additions & 0 deletions test/command/feed.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,91 @@ describeCommand(
expect(getLastMessage()).toContain('Number of Updates')
expect(getLastMessage()).toContain('2')
})

it('should write to correct index', async () => {
// create identity
await invokeTestCli(['identity', 'create', 'test', '--password', 'test'])
// upload data to index 22
await invokeTestCli([
'feed',
'upload',
`${__dirname}/../testpage/images/swarm.png`,
'--identity',
'test',
'--topic-string',
'test',
'--password',
'test',
'--quiet',
'--index',
'22',
...getStampOption(),
])
// print with identity and password
await invokeTestCli([
'feed',
'print',
'--identity',
'test',
'--topic-string',
'test',
'--password',
'test',
'--quiet',
'--index',
'22',
...getStampOption(),
])
expect(getLastMessage()).toMatch(/[a-z0-9]{64}/)

// Zero index should work as well
await invokeTestCli(['identity', 'create', 'test', '--password', 'test'])
await invokeTestCli([
'feed',
'upload',
`${__dirname}/../testpage/images/swarm.png`,
'--identity', 'test',
'--topic-string',
'test',
'--password',
'test',
'--quiet',
'--index',
'0',
...getStampOption(),
])
await invokeTestCli([
'feed',
'print',
'--identity',
'test',
'--topic-string',
'test',
'--password',
'test',
'--quiet',
'--index',
'0',
...getStampOption(),
])
expect(getLastMessage()).toMatch(/[a-z0-9]{64}/)

// It should work without specifying the index as well
await invokeTestCli([
'feed',
'print',
'--identity',
'test',
'--topic-string',
'test',
'--password',
'test',
'--quiet',
...getStampOption(),
])
expect(getLastMessage()).toMatch(/[a-z0-9]{64}/)
})

},
{ configFileName: 'feed' },
)