Fixed MemoryStore.list_dir - #2117

Merged
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir
Aug 26, 2024
Merged

Fixed MemoryStore.list_dir#2117
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir

Conversation

@TomAugspurger

Copy link
Copy Markdown
Contributor

Ensures that nested children are listed properly.

Closes#2116

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Ensures that nested children are listed properly.
Comment threadsrc/zarr/testing/store.py Outdated
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

keys_expected = ["foo"]

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Ah, this is failing on the S3 tests.

 keys_expected = ["foo"]
keys_observed = [k asyncfor k in store.list_dir("")]
> assert set(keys_observed) == set(keys_expected), keys_observed
E AssertionError: ['test/foo']

It's including self.path (the bucket name?) in listing. Based on my reading of the tests, that should not be included, but I'm not 100% sure. 90940a0 has that fix

This was referenced Aug 25, 2024

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm struggling to get my head around the new logic. Reading #2116, is the goal here to just not return any duplicate values? If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

@TomAugspurger

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

is the goal here to just not return any duplicate values?

Effectively yes. Duplicate keys were a consequence of the previous implementation not handling arrays nested in child groups properly.

If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

3c845d9 has an approach that's a middle ground between my previous fix and your suggestion. I think it's a lot simpler. It does still generate all the keys before yield them, but I'm not too worried about that. This is an in-memory store, so things should be pretty small and fast, and this matches the implementation of the non-prefix case.

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍 looks good to me. I think if you drop the last bit of the assert statement, pytest is clever and will report the difference between the two sets in it's output when the test fails.

Comment threadsrc/zarr/testing/store.py Outdated
Co-authored-by: David Stansby <dstansby@gmail.com>

@jhammanjhamman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice catch @TomAugspurger!

Comment threadsrc/zarr/store/memory.py
Comment threadsrc/zarr/testing/store.py Outdated
Comment on lines +194 to +197
await store.set("foo/c/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think its super material to the test but I believe the intent of this test was to have foo be an array c be the subdirectory containing chunks. Perhaps it would be better to change this to something more like:

Suggested change
awaitstore.set("foo/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/2", Buffer.from_bytes(b"\x01"))

@TomAugspurgerTomAugspurgerAug 26, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right... IIUC, if you have a key at foo/zarr.json with a node_type="array", that implies you won't have any keys at foo/bar/zarr.json (a group or a node), since arrays can't have children?

I tried to update this in 7414b10, to make sure that the test store we construct is at least compatible with how a Zarr hierarchy would be laid out.

/foo # group
/c # array
/group-0
/group-1
/array-0
/array-1
/array-2

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks great!

@jhamman
jhamman merged commit 61683be into zarr-developers:v3Aug 26, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MemoryStore.list_dir incorrectly includes non-immediate children

3 participants

@TomAugspurger@jhamman@dstansby
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Fixed MemoryStore.list_dir - #2117

Merged
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir
Aug 26, 2024
Merged

Fixed MemoryStore.list_dir#2117
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir

Conversation

@TomAugspurger

Copy link
Copy Markdown
Contributor

Ensures that nested children are listed properly.

Closes#2116

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Ensures that nested children are listed properly.
Comment threadsrc/zarr/testing/store.py Outdated
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

keys_expected = ["foo"]

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Ah, this is failing on the S3 tests.

 keys_expected = ["foo"]
keys_observed = [k asyncfor k in store.list_dir("")]
> assert set(keys_observed) == set(keys_expected), keys_observed
E AssertionError: ['test/foo']

It's including self.path (the bucket name?) in listing. Based on my reading of the tests, that should not be included, but I'm not 100% sure. 90940a0 has that fix

This was referenced Aug 25, 2024

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm struggling to get my head around the new logic. Reading #2116, is the goal here to just not return any duplicate values? If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

@TomAugspurger

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

is the goal here to just not return any duplicate values?

Effectively yes. Duplicate keys were a consequence of the previous implementation not handling arrays nested in child groups properly.

If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

3c845d9 has an approach that's a middle ground between my previous fix and your suggestion. I think it's a lot simpler. It does still generate all the keys before yield them, but I'm not too worried about that. This is an in-memory store, so things should be pretty small and fast, and this matches the implementation of the non-prefix case.

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍 looks good to me. I think if you drop the last bit of the assert statement, pytest is clever and will report the difference between the two sets in it's output when the test fails.

Comment threadsrc/zarr/testing/store.py Outdated
Co-authored-by: David Stansby <dstansby@gmail.com>

@jhammanjhamman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice catch @TomAugspurger!

Comment threadsrc/zarr/store/memory.py
Comment threadsrc/zarr/testing/store.py Outdated
Comment on lines +194 to +197
await store.set("foo/c/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think its super material to the test but I believe the intent of this test was to have foo be an array c be the subdirectory containing chunks. Perhaps it would be better to change this to something more like:

Suggested change
awaitstore.set("foo/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/2", Buffer.from_bytes(b"\x01"))

@TomAugspurgerTomAugspurgerAug 26, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right... IIUC, if you have a key at foo/zarr.json with a node_type="array", that implies you won't have any keys at foo/bar/zarr.json (a group or a node), since arrays can't have children?

I tried to update this in 7414b10, to make sure that the test store we construct is at least compatible with how a Zarr hierarchy would be laid out.

/foo # group
/c # array
/group-0
/group-1
/array-0
/array-1
/array-2

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks great!

@jhamman
jhamman merged commit 61683be into zarr-developers:v3Aug 26, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MemoryStore.list_dir incorrectly includes non-immediate children

3 participants

@TomAugspurger@jhamman@dstansby
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fixed MemoryStore.list_dir - #2117

Merged
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir
Aug 26, 2024
Merged

Fixed MemoryStore.list_dir#2117
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir

Conversation

@TomAugspurger

Copy link
Copy Markdown
Contributor

Ensures that nested children are listed properly.

Closes#2116

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Ensures that nested children are listed properly.
Comment threadsrc/zarr/testing/store.py Outdated
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

keys_expected = ["foo"]

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Ah, this is failing on the S3 tests.

 keys_expected = ["foo"]
keys_observed = [k asyncfor k in store.list_dir("")]
> assert set(keys_observed) == set(keys_expected), keys_observed
E AssertionError: ['test/foo']

It's including self.path (the bucket name?) in listing. Based on my reading of the tests, that should not be included, but I'm not 100% sure. 90940a0 has that fix

This was referenced Aug 25, 2024

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm struggling to get my head around the new logic. Reading #2116, is the goal here to just not return any duplicate values? If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

@TomAugspurger

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

is the goal here to just not return any duplicate values?

Effectively yes. Duplicate keys were a consequence of the previous implementation not handling arrays nested in child groups properly.

If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

3c845d9 has an approach that's a middle ground between my previous fix and your suggestion. I think it's a lot simpler. It does still generate all the keys before yield them, but I'm not too worried about that. This is an in-memory store, so things should be pretty small and fast, and this matches the implementation of the non-prefix case.

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍 looks good to me. I think if you drop the last bit of the assert statement, pytest is clever and will report the difference between the two sets in it's output when the test fails.

Comment threadsrc/zarr/testing/store.py Outdated
Co-authored-by: David Stansby <dstansby@gmail.com>

@jhammanjhamman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice catch @TomAugspurger!

Comment threadsrc/zarr/store/memory.py
Comment threadsrc/zarr/testing/store.py Outdated
Comment on lines +194 to +197
await store.set("foo/c/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think its super material to the test but I believe the intent of this test was to have foo be an array c be the subdirectory containing chunks. Perhaps it would be better to change this to something more like:

Suggested change
awaitstore.set("foo/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/2", Buffer.from_bytes(b"\x01"))

@TomAugspurgerTomAugspurgerAug 26, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right... IIUC, if you have a key at foo/zarr.json with a node_type="array", that implies you won't have any keys at foo/bar/zarr.json (a group or a node), since arrays can't have children?

I tried to update this in 7414b10, to make sure that the test store we construct is at least compatible with how a Zarr hierarchy would be laid out.

/foo # group
/c # array
/group-0
/group-1
/array-0
/array-1
/array-2

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks great!

@jhamman
jhamman merged commit 61683be into zarr-developers:v3Aug 26, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MemoryStore.list_dir incorrectly includes non-immediate children

3 participants

@TomAugspurger@jhamman@dstansby
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fixed MemoryStore.list_dir - #2117

Merged
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir
Aug 26, 2024
Merged

Fixed MemoryStore.list_dir#2117
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir

Conversation

@TomAugspurger

Copy link
Copy Markdown
Contributor

Ensures that nested children are listed properly.

Closes#2116

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Ensures that nested children are listed properly.
Comment threadsrc/zarr/testing/store.py Outdated
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

keys_expected = ["foo"]

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Ah, this is failing on the S3 tests.

 keys_expected = ["foo"]
keys_observed = [k asyncfor k in store.list_dir("")]
> assert set(keys_observed) == set(keys_expected), keys_observed
E AssertionError: ['test/foo']

It's including self.path (the bucket name?) in listing. Based on my reading of the tests, that should not be included, but I'm not 100% sure. 90940a0 has that fix

This was referenced Aug 25, 2024

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm struggling to get my head around the new logic. Reading #2116, is the goal here to just not return any duplicate values? If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

@TomAugspurger

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

is the goal here to just not return any duplicate values?

Effectively yes. Duplicate keys were a consequence of the previous implementation not handling arrays nested in child groups properly.

If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

3c845d9 has an approach that's a middle ground between my previous fix and your suggestion. I think it's a lot simpler. It does still generate all the keys before yield them, but I'm not too worried about that. This is an in-memory store, so things should be pretty small and fast, and this matches the implementation of the non-prefix case.

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍 looks good to me. I think if you drop the last bit of the assert statement, pytest is clever and will report the difference between the two sets in it's output when the test fails.

Comment threadsrc/zarr/testing/store.py Outdated
Co-authored-by: David Stansby <dstansby@gmail.com>

@jhammanjhamman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice catch @TomAugspurger!

Comment threadsrc/zarr/store/memory.py
Comment threadsrc/zarr/testing/store.py Outdated
Comment on lines +194 to +197
await store.set("foo/c/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think its super material to the test but I believe the intent of this test was to have foo be an array c be the subdirectory containing chunks. Perhaps it would be better to change this to something more like:

Suggested change
awaitstore.set("foo/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/2", Buffer.from_bytes(b"\x01"))

@TomAugspurgerTomAugspurgerAug 26, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right... IIUC, if you have a key at foo/zarr.json with a node_type="array", that implies you won't have any keys at foo/bar/zarr.json (a group or a node), since arrays can't have children?

I tried to update this in 7414b10, to make sure that the test store we construct is at least compatible with how a Zarr hierarchy would be laid out.

/foo # group
/c # array
/group-0
/group-1
/array-0
/array-1
/array-2

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks great!

@jhamman
jhamman merged commit 61683be into zarr-developers:v3Aug 26, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MemoryStore.list_dir incorrectly includes non-immediate children

3 participants

@TomAugspurger@jhamman@dstansby
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Fixed MemoryStore.list_dir - #2117

Merged
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir
Aug 26, 2024
Merged

Fixed MemoryStore.list_dir#2117
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir

Conversation

@TomAugspurger

Copy link
Copy Markdown
Contributor

Ensures that nested children are listed properly.

Closes#2116

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Ensures that nested children are listed properly.
Comment threadsrc/zarr/testing/store.py Outdated
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

keys_expected = ["foo"]

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Ah, this is failing on the S3 tests.

 keys_expected = ["foo"]
keys_observed = [k asyncfor k in store.list_dir("")]
> assert set(keys_observed) == set(keys_expected), keys_observed
E AssertionError: ['test/foo']

It's including self.path (the bucket name?) in listing. Based on my reading of the tests, that should not be included, but I'm not 100% sure. 90940a0 has that fix

This was referenced Aug 25, 2024

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm struggling to get my head around the new logic. Reading #2116, is the goal here to just not return any duplicate values? If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

@TomAugspurger

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

is the goal here to just not return any duplicate values?

Effectively yes. Duplicate keys were a consequence of the previous implementation not handling arrays nested in child groups properly.

If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

3c845d9 has an approach that's a middle ground between my previous fix and your suggestion. I think it's a lot simpler. It does still generate all the keys before yield them, but I'm not too worried about that. This is an in-memory store, so things should be pretty small and fast, and this matches the implementation of the non-prefix case.

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍 looks good to me. I think if you drop the last bit of the assert statement, pytest is clever and will report the difference between the two sets in it's output when the test fails.

Comment threadsrc/zarr/testing/store.py Outdated
Co-authored-by: David Stansby <dstansby@gmail.com>

@jhammanjhamman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice catch @TomAugspurger!

Comment threadsrc/zarr/store/memory.py
Comment threadsrc/zarr/testing/store.py Outdated
Comment on lines +194 to +197
await store.set("foo/c/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think its super material to the test but I believe the intent of this test was to have foo be an array c be the subdirectory containing chunks. Perhaps it would be better to change this to something more like:

Suggested change
awaitstore.set("foo/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/2", Buffer.from_bytes(b"\x01"))

@TomAugspurgerTomAugspurgerAug 26, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right... IIUC, if you have a key at foo/zarr.json with a node_type="array", that implies you won't have any keys at foo/bar/zarr.json (a group or a node), since arrays can't have children?

I tried to update this in 7414b10, to make sure that the test store we construct is at least compatible with how a Zarr hierarchy would be laid out.

/foo # group
/c # array
/group-0
/group-1
/array-0
/array-1
/array-2

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks great!

@jhamman
jhamman merged commit 61683be into zarr-developers:v3Aug 26, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MemoryStore.list_dir incorrectly includes non-immediate children

3 participants

@TomAugspurger@jhamman@dstansby
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fixed MemoryStore.list_dir - #2117

Merged
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir
Aug 26, 2024
Merged

Fixed MemoryStore.list_dir#2117
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir

Conversation

@TomAugspurger

Copy link
Copy Markdown
Contributor

Ensures that nested children are listed properly.

Closes#2116

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Ensures that nested children are listed properly.
Comment threadsrc/zarr/testing/store.py Outdated
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

keys_expected = ["foo"]

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Ah, this is failing on the S3 tests.

 keys_expected = ["foo"]
keys_observed = [k asyncfor k in store.list_dir("")]
> assert set(keys_observed) == set(keys_expected), keys_observed
E AssertionError: ['test/foo']

It's including self.path (the bucket name?) in listing. Based on my reading of the tests, that should not be included, but I'm not 100% sure. 90940a0 has that fix

This was referenced Aug 25, 2024

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm struggling to get my head around the new logic. Reading #2116, is the goal here to just not return any duplicate values? If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

@TomAugspurger

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

is the goal here to just not return any duplicate values?

Effectively yes. Duplicate keys were a consequence of the previous implementation not handling arrays nested in child groups properly.

If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

3c845d9 has an approach that's a middle ground between my previous fix and your suggestion. I think it's a lot simpler. It does still generate all the keys before yield them, but I'm not too worried about that. This is an in-memory store, so things should be pretty small and fast, and this matches the implementation of the non-prefix case.

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍 looks good to me. I think if you drop the last bit of the assert statement, pytest is clever and will report the difference between the two sets in it's output when the test fails.

Comment threadsrc/zarr/testing/store.py Outdated
Co-authored-by: David Stansby <dstansby@gmail.com>

@jhammanjhamman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice catch @TomAugspurger!

Comment threadsrc/zarr/store/memory.py
Comment threadsrc/zarr/testing/store.py Outdated
Comment on lines +194 to +197
await store.set("foo/c/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think its super material to the test but I believe the intent of this test was to have foo be an array c be the subdirectory containing chunks. Perhaps it would be better to change this to something more like:

Suggested change
awaitstore.set("foo/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/2", Buffer.from_bytes(b"\x01"))

@TomAugspurgerTomAugspurgerAug 26, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right... IIUC, if you have a key at foo/zarr.json with a node_type="array", that implies you won't have any keys at foo/bar/zarr.json (a group or a node), since arrays can't have children?

I tried to update this in 7414b10, to make sure that the test store we construct is at least compatible with how a Zarr hierarchy would be laid out.

/foo # group
/c # array
/group-0
/group-1
/array-0
/array-1
/array-2

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks great!

@jhamman
jhamman merged commit 61683be into zarr-developers:v3Aug 26, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MemoryStore.list_dir incorrectly includes non-immediate children

3 participants

@TomAugspurger@jhamman@dstansby
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fixed MemoryStore.list_dir - #2117

Merged
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir
Aug 26, 2024
Merged

Fixed MemoryStore.list_dir#2117
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir

Conversation

@TomAugspurger

Copy link
Copy Markdown
Contributor

Ensures that nested children are listed properly.

Closes#2116

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Ensures that nested children are listed properly.
Comment threadsrc/zarr/testing/store.py Outdated
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

keys_expected = ["foo"]

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Ah, this is failing on the S3 tests.

 keys_expected = ["foo"]
keys_observed = [k asyncfor k in store.list_dir("")]
> assert set(keys_observed) == set(keys_expected), keys_observed
E AssertionError: ['test/foo']

It's including self.path (the bucket name?) in listing. Based on my reading of the tests, that should not be included, but I'm not 100% sure. 90940a0 has that fix

This was referenced Aug 25, 2024

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm struggling to get my head around the new logic. Reading #2116, is the goal here to just not return any duplicate values? If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

@TomAugspurger

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

is the goal here to just not return any duplicate values?

Effectively yes. Duplicate keys were a consequence of the previous implementation not handling arrays nested in child groups properly.

If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

3c845d9 has an approach that's a middle ground between my previous fix and your suggestion. I think it's a lot simpler. It does still generate all the keys before yield them, but I'm not too worried about that. This is an in-memory store, so things should be pretty small and fast, and this matches the implementation of the non-prefix case.

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍 looks good to me. I think if you drop the last bit of the assert statement, pytest is clever and will report the difference between the two sets in it's output when the test fails.

Comment threadsrc/zarr/testing/store.py Outdated
Co-authored-by: David Stansby <dstansby@gmail.com>

@jhammanjhamman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice catch @TomAugspurger!

Comment threadsrc/zarr/store/memory.py
Comment threadsrc/zarr/testing/store.py Outdated
Comment on lines +194 to +197
await store.set("foo/c/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think its super material to the test but I believe the intent of this test was to have foo be an array c be the subdirectory containing chunks. Perhaps it would be better to change this to something more like:

Suggested change
awaitstore.set("foo/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/2", Buffer.from_bytes(b"\x01"))

@TomAugspurgerTomAugspurgerAug 26, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right... IIUC, if you have a key at foo/zarr.json with a node_type="array", that implies you won't have any keys at foo/bar/zarr.json (a group or a node), since arrays can't have children?

I tried to update this in 7414b10, to make sure that the test store we construct is at least compatible with how a Zarr hierarchy would be laid out.

/foo # group
/c # array
/group-0
/group-1
/array-0
/array-1
/array-2

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks great!

@jhamman
jhamman merged commit 61683be into zarr-developers:v3Aug 26, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MemoryStore.list_dir incorrectly includes non-immediate children

3 participants

@TomAugspurger@jhamman@dstansby
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Fixed MemoryStore.list_dir - #2117

Merged
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir
Aug 26, 2024
Merged

Fixed MemoryStore.list_dir#2117
jhamman merged 5 commits into
zarr-developers:v3from
TomAugspurger:fix/list-dir

Conversation

@TomAugspurger

Copy link
Copy Markdown
Contributor

Ensures that nested children are listed properly.

Closes#2116

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Ensures that nested children are listed properly.
Comment threadsrc/zarr/testing/store.py Outdated
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

keys_expected = ["foo"]

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Ah, this is failing on the S3 tests.

 keys_expected = ["foo"]
keys_observed = [k asyncfor k in store.list_dir("")]
> assert set(keys_observed) == set(keys_expected), keys_observed
E AssertionError: ['test/foo']

It's including self.path (the bucket name?) in listing. Based on my reading of the tests, that should not be included, but I'm not 100% sure. 90940a0 has that fix

This was referenced Aug 25, 2024

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm struggling to get my head around the new logic. Reading #2116, is the goal here to just not return any duplicate values? If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

@TomAugspurger

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review!

is the goal here to just not return any duplicate values?

Effectively yes. Duplicate keys were a consequence of the previous implementation not handling arrays nested in child groups properly.

If so, I wonder if it would be easier to keep track of the values that have been returned, and only yield a value if it hasn't been returned yet (otherwise, check the next value). This way it would also truly generate the values one at a time, instead of the new approach that computes all the keys before yielding them.

3c845d9 has an approach that's a middle ground between my previous fix and your suggestion. I think it's a lot simpler. It does still generate all the keys before yield them, but I'm not too worried about that. This is an in-memory store, so things should be pretty small and fast, and this matches the implementation of the non-prefix case.

@dstansbydstansby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍 looks good to me. I think if you drop the last bit of the assert statement, pytest is clever and will report the difference between the two sets in it's output when the test fails.

Comment threadsrc/zarr/testing/store.py Outdated
Co-authored-by: David Stansby <dstansby@gmail.com>

@jhammanjhamman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice catch @TomAugspurger!

Comment threadsrc/zarr/store/memory.py
Comment threadsrc/zarr/testing/store.py Outdated
Comment on lines +194 to +197
await store.set("foo/c/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
await store.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think its super material to the test but I believe the intent of this test was to have foo be an array c be the subdirectory containing chunks. Perhaps it would be better to change this to something more like:

Suggested change
awaitstore.set("foo/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/c/d/3", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/bar/c/2", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/1", Buffer.from_bytes(b"\x01"))
awaitstore.set("foo/spam/c/2", Buffer.from_bytes(b"\x01"))

@TomAugspurgerTomAugspurgerAug 26, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right... IIUC, if you have a key at foo/zarr.json with a node_type="array", that implies you won't have any keys at foo/bar/zarr.json (a group or a node), since arrays can't have children?

I tried to update this in 7414b10, to make sure that the test store we construct is at least compatible with how a Zarr hierarchy would be laid out.

/foo # group
/c # array
/group-0
/group-1
/array-0
/array-1
/array-2

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks great!

@jhamman
jhamman merged commit 61683be into zarr-developers:v3Aug 26, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MemoryStore.list_dir incorrectly includes non-immediate children

3 participants

@TomAugspurger@jhamman@dstansby