Collections

[josephjclark]

Summary

Adds a new Collections adaptor

Fixes #758

TODO

• Pass query options like updated_before
• Add proper documentation
• Add richer logging output
• Maybe mock date filters for better tests? Doesn't really feel material...

Details

The adaptor provides a fairly simple API.

This implementation and tests rely heavily on a little mock collections server, which uses undici interceptors.

At the moment, because there's no backend and no worker support, the adaptor really only works through the mock interface.

Here's a test job which works through the CLI:

// Set up the test
fn((state = {}) => {
  // set up a mock
  const server = mock.createServer();
  collections.setMockClient(server);

  server.api.createCollection('collection');

  state.configuration = {
    collections_token: 'abc',
  };

  state.data = [
    { key: 'a', value: { id: 'a' } },
    { key: 'b', value: { id: 'b' } },
    { key: 'c', value: { id: 'c' } },
  ];

  return state;
});

collections.set('collection', $.data);

collections.each('collection', '*', (state, key, value) => {
  console.log(key, value);
});

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to know!):

• Code generation (copilot but not intellisense)
• Learning or fact checking
• Strategy / design
• Optimisation / refactoring
• Translation / spellchecking / doc gen
• Other
• I have not used AI

You can read more details in our Responsible AI Policy

[josephjclark]

Here's a thought: do we need to do something to stop the collections adaptor appearing in the lightning drop-down list? 🤔