10913046901

Committed 18 Sep 2024 12:02AM UTC coverage: 31.846% (-0.004%) from 31.85%

Build # 10913046901

Build Type

Pull #9764

github

Committed by

jimrandomh

Commit Message

Loading the current spotlight uses loaders

Pull Request Pull Request #9764: Collected small changes

Run Details

5077 of 41379 branches covered (12.27%)

Branch coverage included in aggregate %.

28 of 52 new or added lines in 8 files covered. (53.85%)

3 existing lines in 3 files now uncovered.

29441 of 67012 relevant lines covered (43.93%)

184.64 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

10.77

/packages/lesswrong/lib/collections/spotlights/schema.ts

import range from "lodash/range";
import { schemaDefaultValue, resolverOnlyField, accessFilterSingle, accessFilterMultiple } from "../../utils/schemaUtils";
import { graphqlTypeToCollectionName } from "../../vulcan-lib/collections";
import { isLWorAF } from "../../instanceSettings";

const DOCUMENT_TYPES = ['Sequence', 'Post'];

interface ShiftSpotlightItemParams {
  startBound: number;
  endBound: number;
  offset: -1 | 1;
  context: ResolverContext;
}

/**
 * Range is not inclusive of the "end"
 * 
 * ex: Moving item from position 7 to position 3.  We want to shift items in the range of positions [3..6] to [4..7].
 * 
 * So range(3, 7) gives us [3,4,5,6].
 * 
 * `offset: -1` is to push items "backward" (when you're either creating a new spotlight item in the middle of the existing set, or moving one earlier in the order)
 * 
 * `offset: 1` is to pull items "forward" (when you're moving an existing item back)
 */
const shiftSpotlightItems = async ({ startBound, endBound, offset, context }: ShiftSpotlightItemParams) => {
  const shiftRange = range(startBound, endBound);

  // Shift the intermediate spotlights backward or forward (according to `offset`)
  await context.Spotlights.rawUpdateMany({ position: { $in: shiftRange } }, { $inc: { position: offset } }, { multi:true });
};

const schema: SchemaType<"Spotlights"> = {
  documentId: {
    type: String,
    nullable: false,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    order: 10,
    resolveAs: {
      fieldName: 'document',
      addOriginalField: true,
      // TODO: try a graphql union type?
      type: 'Post!',
      resolver: async (spotlight: DbSpotlight, args: void, context: ResolverContext): Promise<Partial<DbPost | DbSequence | DbCollection> | null> => {
        switch(spotlight.documentType) {
          case "Post": {
            const document = await context.loaders.Posts.load(spotlight.documentId);
            return accessFilterSingle(context.currentUser, context.Posts, document, context);
          }
          case "Sequence": {
            const document = await context.loaders.Sequences.load(spotlight.documentId);
            return accessFilterSingle(context.currentUser, context.Sequences, document, context);
          }
        }
      }
    },
  },
  
  /**
   * Type of document that is spotlighted, from the options in DOCUMENT_TYPES.
   * Note subtle distinction: those are type names, not collection names.
   */
  documentType: {
    type: String,
    typescriptType: 'SpotlightDocumentType',
    control: 'select',
    form: {
      options: () => DOCUMENT_TYPES.map(documentType => ({ label: documentType, value: documentType }))
    },
    ...schemaDefaultValue(DOCUMENT_TYPES[0]),
    allowedValues: DOCUMENT_TYPES,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    order: 20,
  },
  position: {
    type: Number,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    order: 30,
    optional: true,
    nullable: false,
    onCreate: async ({ newDocument, context }) => {
      const [currentSpotlight, lastSpotlightByPosition] = await Promise.all([
        context.Spotlights.findOne({}, { sort: { lastPromotedAt: -1 } }),
        context.Spotlights.findOne({}, { sort: { position: -1 } })
      ]);
      
      // If we don't have an active spotlight (or any spotlight), the new one should be first
      if (!currentSpotlight || !lastSpotlightByPosition) {
        return 0;
      }

      // If we didn't specify a position, by default we probably want to be inserting it right after the currently-active spotlight
      // If we're instead putting the created spotlight somewhere before the last spotlight, shift everything at and after the desired position back
      const startBound = typeof newDocument.position !== 'number' ? currentSpotlight.position + 1 : newDocument.position;
      const endBound = lastSpotlightByPosition.position + 1;

      // Don't let us create a new spotlight with an arbitrarily large position
      if (newDocument.position > endBound) {
        return endBound;
      }

      // Push all the spotlight items both at and after the about-to-be-created item's position back by 1
      await shiftSpotlightItems({ startBound, endBound, offset: 1, context });

      // The to-be-created spotlight's position
      return startBound;
    },
    onUpdate: async ({ data, oldDocument, context }) => {
      if (typeof data.position === 'number' && data.position !== oldDocument.position) {
        // Figure out whether we're moving an existing spotlight item to an earlier position or a later position
        const pullingSpotlightForward = data.position < oldDocument.position;

        // Use that to determine which other spotlight items we need to move, and whether we correspondingly push them back or pull them forward
        const startBound = pullingSpotlightForward ? data.position : oldDocument.position + 1;
        const endBound = pullingSpotlightForward ? oldDocument.position : data.position + 1;
        const offset = pullingSpotlightForward ? 1 : -1;

        // Set the to-be-updated spotlight's position to something far out to avoid conflict with the spotlights we'll need to shift back
        await context.Spotlights.rawUpdateOne({ _id: oldDocument._id }, { $set: { position: 9001 } });

        // Shift the intermediate items backward
        await shiftSpotlightItems({ startBound, endBound, offset, context });        

        // The to-be-updated spotlight's position will get updated back to the desired position later in the mutator
        return data.position;
      }
    }
  },
  duration: {
    type: Number,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    order: 40,
    ...schemaDefaultValue(3),
  },
  customTitle: {
    type: String,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    order: 50,
    optional: true,
    nullable: true
  },
  customSubtitle: {
    type: String,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    order: 60,
    optional: true,
    nullable: true
  },
  subtitleUrl: {
    type: String,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    order: 61,
    optional: true,
    nullable: true
  },
  headerTitle: {
    type: String,
    canRead: ["guests"],
    canUpdate: ["admins", "sunshineRegiment"],
    canCreate: ["admins", "sunshineRegiment"],
    order: 65,
    optional: true,
    nullable: true,
  },
  headerTitleLeftColor: {
    type: String,
    canRead: ["guests"],
    canUpdate: ["admins", "sunshineRegiment"],
    canCreate: ["admins", "sunshineRegiment"],
    order: 66,
    optional: true,
    nullable: true,
  },
  headerTitleRightColor: {
    type: String,
    canRead: ["guests"],
    canUpdate: ["admins", "sunshineRegiment"],
    canCreate: ["admins", "sunshineRegiment"],
    order: 67,
    optional: true,
    nullable: true,
  },
  lastPromotedAt: {
    type: Date,
    control: "datetime",
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    order: 70,
    // Default to the epoch date if not specified
    ...schemaDefaultValue(new Date(0)),
  },
  spotlightSplashImageUrl: {
    type: String,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    optional: true,
    nullable: true,
    order: 88,
  },
  draft: {
    type: Boolean,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    order: 80,
    ...schemaDefaultValue(true),
  },
  deletedDraft: {
    type: Boolean,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    order: 80,
    optional: true,
    nullable: true,
    tooltip: "Remove from the spotlights page, but keep in the database.",
    ...schemaDefaultValue(false),
  },
  showAuthor: {
    type: Boolean,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    order: 85,
    ...schemaDefaultValue(false),
   optional: true,
   nullable: false,
  },
  imageFade: {
    type: Boolean,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    order: 86,
    optional: true,
    nullable: false,
    // we're not using schemaDefaultValue because we can't use forumType
    // conditionals without breaking schema hash logic
    defaultValue: true,
    onCreate: ({document}) => document.imageFade ?? (isLWorAF ? false : true),
    canAutofillDefault: true,
  },
  imageFadeColor: {
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    type: String,
    order: 87,
    optional: true,
    nullable: true,
    control: "FormComponentColorPicker",
  },

  spotlightImageId: {
    type: String,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    control: "ImageUpload",
    optional: true,
    nullable: true,
    order: 90,
  },
  spotlightDarkImageId: {
    type: String,
    canRead: ['guests'],
    canUpdate: ['admins', 'sunshineRegiment'],
    canCreate: ['admins', 'sunshineRegiment'],
    control: "ImageUpload",
    optional: true,
    nullable: true,
    order: 100,
  },
  sequenceChapters: resolverOnlyField({
    type: Array,
    graphQLtype: '[Chapter]',
    canRead: ['guests'],
    resolver: async (spotlight: DbSpotlight, args: void, context: ResolverContext): Promise<Partial<DbChapter>[]|null> => {
      if (!spotlight.documentId || spotlight.documentType !== "Sequence") {
        return null;
      }
      const chapters = await context.Chapters.find({
        sequenceId: spotlight.documentId,
      }, {
        limit: 100,
        sort: {number:1},
      }).fetch();
      
      return await accessFilterMultiple(context.currentUser, context.Chapters, chapters, context);
    }
  }),
  "sequenceChapters.$": {
    type: "Chapter",
    foreignKey: "Chapters",
    optional: true,
  },
};

export default schema;

1	import range from "lodash/range";	80✔
2	import { schemaDefaultValue, resolverOnlyField, accessFilterSingle, accessFilterMultiple } from "../../utils/schemaUtils";	20✔
3	import { graphqlTypeToCollectionName } from "../../vulcan-lib/collections";
4	import { isLWorAF } from "../../instanceSettings";	20✔
5
6	const DOCUMENT_TYPES = ['Sequence', 'Post'];	20✔
7
8	interface ShiftSpotlightItemParams {
9	startBound: number;
10	endBound: number;
11	offset: -1 \| 1;
12	context: ResolverContext;
13	}
14
15	/**
16	* Range is not inclusive of the "end"
17	*
18	* ex: Moving item from position 7 to position 3. We want to shift items in the range of positions [3..6] to [4..7].
19	*
20	* So range(3, 7) gives us [3,4,5,6].
21	*
22	* `offset: -1` is to push items "backward" (when you're either creating a new spotlight item in the middle of the existing set, or moving one earlier in the order)
23	*
24	* `offset: 1` is to pull items "forward" (when you're moving an existing item back)
25	*/
26	const shiftSpotlightItems = async ({ startBound, endBound, offset, context }: ShiftSpotlightItemParams) => {	20✔
27	const shiftRange = range(startBound, endBound);	×
28
29	// Shift the intermediate spotlights backward or forward (according to `offset`)
30	await context.Spotlights.rawUpdateMany({ position: { $in: shiftRange } }, { $inc: { position: offset } }, { multi:true });	×
31	};
32
33	const schema: SchemaType<"Spotlights"> = {	20✔
34	documentId: {
35	type: String,
36	nullable: false,
37	canRead: ['guests'],
38	canUpdate: ['admins', 'sunshineRegiment'],
39	canCreate: ['admins', 'sunshineRegiment'],
40	order: 10,
41	resolveAs: {
42	fieldName: 'document',
43	addOriginalField: true,
44	// TODO: try a graphql union type?
45	type: 'Post!',
46	resolver: async (spotlight: DbSpotlight, args: void, context: ResolverContext): Promise<Partial<DbPost \| DbSequence \| DbCollection> \| null> => {
NEW 47	switch(spotlight.documentType) {	×
48	case "Post": {
NEW 49	const document = await context.loaders.Posts.load(spotlight.documentId);	×
NEW 50	return accessFilterSingle(context.currentUser, context.Posts, document, context);	×
51	}
52	case "Sequence": {
NEW 53	const document = await context.loaders.Sequences.load(spotlight.documentId);	×
NEW 54	return accessFilterSingle(context.currentUser, context.Sequences, document, context);	×
55	}
56	}
57	}
58	},
59	},
60
61	/**
62	* Type of document that is spotlighted, from the options in DOCUMENT_TYPES.
63	* Note subtle distinction: those are type names, not collection names.
64	*/
65	documentType: {
66	type: String,
67	typescriptType: 'SpotlightDocumentType',
68	control: 'select',
69	form: {
70	options: () => DOCUMENT_TYPES.map(documentType => ({ label: documentType, value: documentType }))	×
71	},
72	...schemaDefaultValue(DOCUMENT_TYPES[0]),
73	allowedValues: DOCUMENT_TYPES,
74	canRead: ['guests'],
75	canUpdate: ['admins', 'sunshineRegiment'],
76	canCreate: ['admins', 'sunshineRegiment'],
77	order: 20,
78	},
79	position: {
80	type: Number,
81	canRead: ['guests'],
82	canUpdate: ['admins', 'sunshineRegiment'],
83	canCreate: ['admins', 'sunshineRegiment'],
84	order: 30,
85	optional: true,
86	nullable: false,
87	onCreate: async ({ newDocument, context }) => {
88	const [currentSpotlight, lastSpotlightByPosition] = await Promise.all([	×
89	context.Spotlights.findOne({}, { sort: { lastPromotedAt: -1 } }),
90	context.Spotlights.findOne({}, { sort: { position: -1 } })
91	]);
92
93	// If we don't have an active spotlight (or any spotlight), the new one should be first
94	if (!currentSpotlight \|\| !lastSpotlightByPosition) {	×
95	return 0;	×
96	}
97
98	// If we didn't specify a position, by default we probably want to be inserting it right after the currently-active spotlight
99	// If we're instead putting the created spotlight somewhere before the last spotlight, shift everything at and after the desired position back
100	const startBound = typeof newDocument.position !== 'number' ? currentSpotlight.position + 1 : newDocument.position;	×
101	const endBound = lastSpotlightByPosition.position + 1;	×
102
103	// Don't let us create a new spotlight with an arbitrarily large position
104	if (newDocument.position > endBound) {	×
105	return endBound;	×
106	}
107
108	// Push all the spotlight items both at and after the about-to-be-created item's position back by 1
109	await shiftSpotlightItems({ startBound, endBound, offset: 1, context });	×
110
111	// The to-be-created spotlight's position
112	return startBound;	×
113	},
114	onUpdate: async ({ data, oldDocument, context }) => {
115	if (typeof data.position === 'number' && data.position !== oldDocument.position) {	×
116	// Figure out whether we're moving an existing spotlight item to an earlier position or a later position
117	const pullingSpotlightForward = data.position < oldDocument.position;	×
118
119	// Use that to determine which other spotlight items we need to move, and whether we correspondingly push them back or pull them forward
120	const startBound = pullingSpotlightForward ? data.position : oldDocument.position + 1;	×
121	const endBound = pullingSpotlightForward ? oldDocument.position : data.position + 1;	×
122	const offset = pullingSpotlightForward ? 1 : -1;	×
123
124	// Set the to-be-updated spotlight's position to something far out to avoid conflict with the spotlights we'll need to shift back
125	await context.Spotlights.rawUpdateOne({ _id: oldDocument._id }, { $set: { position: 9001 } });	×
126
127	// Shift the intermediate items backward
128	await shiftSpotlightItems({ startBound, endBound, offset, context });	×
129
130	// The to-be-updated spotlight's position will get updated back to the desired position later in the mutator
131	return data.position;	×
132	}
133	}
134	},
135	duration: {
136	type: Number,
137	canRead: ['guests'],
138	canUpdate: ['admins', 'sunshineRegiment'],
139	canCreate: ['admins', 'sunshineRegiment'],
140	order: 40,
141	...schemaDefaultValue(3),
142	},
143	customTitle: {
144	type: String,
145	canRead: ['guests'],
146	canUpdate: ['admins', 'sunshineRegiment'],
147	canCreate: ['admins', 'sunshineRegiment'],
148	order: 50,
149	optional: true,
150	nullable: true
151	},
152	customSubtitle: {
153	type: String,
154	canRead: ['guests'],
155	canUpdate: ['admins', 'sunshineRegiment'],
156	canCreate: ['admins', 'sunshineRegiment'],
157	order: 60,
158	optional: true,
159	nullable: true
160	},
161	subtitleUrl: {
162	type: String,
163	canRead: ['guests'],
164	canUpdate: ['admins', 'sunshineRegiment'],
165	canCreate: ['admins', 'sunshineRegiment'],
166	order: 61,
167	optional: true,
168	nullable: true
169	},
170	headerTitle: {
171	type: String,
172	canRead: ["guests"],
173	canUpdate: ["admins", "sunshineRegiment"],
174	canCreate: ["admins", "sunshineRegiment"],
175	order: 65,
176	optional: true,
177	nullable: true,
178	},
179	headerTitleLeftColor: {
180	type: String,
181	canRead: ["guests"],
182	canUpdate: ["admins", "sunshineRegiment"],
183	canCreate: ["admins", "sunshineRegiment"],
184	order: 66,
185	optional: true,
186	nullable: true,
187	},
188	headerTitleRightColor: {
189	type: String,
190	canRead: ["guests"],
191	canUpdate: ["admins", "sunshineRegiment"],
192	canCreate: ["admins", "sunshineRegiment"],
193	order: 67,
194	optional: true,
195	nullable: true,
196	},
197	lastPromotedAt: {
198	type: Date,
199	control: "datetime",
200	canRead: ['guests'],
201	canUpdate: ['admins', 'sunshineRegiment'],
202	canCreate: ['admins', 'sunshineRegiment'],
203	order: 70,
204	// Default to the epoch date if not specified
205	...schemaDefaultValue(new Date(0)),
206	},
207	spotlightSplashImageUrl: {
208	type: String,
209	canRead: ['guests'],
210	canUpdate: ['admins', 'sunshineRegiment'],
211	canCreate: ['admins', 'sunshineRegiment'],
212	optional: true,
213	nullable: true,
214	order: 88,
215	},
216	draft: {
217	type: Boolean,
218	canRead: ['guests'],
219	canUpdate: ['admins', 'sunshineRegiment'],
220	canCreate: ['admins', 'sunshineRegiment'],
221	order: 80,
222	...schemaDefaultValue(true),
223	},
224	deletedDraft: {
225	type: Boolean,
226	canRead: ['guests'],
227	canUpdate: ['admins', 'sunshineRegiment'],
228	order: 80,
229	optional: true,
230	nullable: true,
231	tooltip: "Remove from the spotlights page, but keep in the database.",
232	...schemaDefaultValue(false),
233	},
234	showAuthor: {
235	type: Boolean,
236	canRead: ['guests'],
237	canUpdate: ['admins', 'sunshineRegiment'],
238	canCreate: ['admins', 'sunshineRegiment'],
239	order: 85,
240	...schemaDefaultValue(false),
241	optional: true,
242	nullable: false,
243	},
244	imageFade: {
245	type: Boolean,
246	canRead: ['guests'],
247	canUpdate: ['admins', 'sunshineRegiment'],
248	canCreate: ['admins', 'sunshineRegiment'],
249	order: 86,
250	optional: true,
251	nullable: false,
252	// we're not using schemaDefaultValue because we can't use forumType
253	// conditionals without breaking schema hash logic
254	defaultValue: true,
255	onCreate: ({document}) => document.imageFade ?? (isLWorAF ? false : true),	×
256	canAutofillDefault: true,
257	},
258	imageFadeColor: {
259	canRead: ['guests'],
260	canUpdate: ['admins', 'sunshineRegiment'],
261	canCreate: ['admins', 'sunshineRegiment'],
262	type: String,
263	order: 87,
264	optional: true,
265	nullable: true,
266	control: "FormComponentColorPicker",
267	},
268
269	spotlightImageId: {
270	type: String,
271	canRead: ['guests'],
272	canUpdate: ['admins', 'sunshineRegiment'],
273	canCreate: ['admins', 'sunshineRegiment'],
274	control: "ImageUpload",
275	optional: true,
276	nullable: true,
277	order: 90,
278	},
279	spotlightDarkImageId: {
280	type: String,
281	canRead: ['guests'],
282	canUpdate: ['admins', 'sunshineRegiment'],
283	canCreate: ['admins', 'sunshineRegiment'],
284	control: "ImageUpload",
285	optional: true,
286	nullable: true,
287	order: 100,
288	},
289	sequenceChapters: resolverOnlyField({
290	type: Array,
291	graphQLtype: '[Chapter]',
292	canRead: ['guests'],
293	resolver: async (spotlight: DbSpotlight, args: void, context: ResolverContext): Promise<Partial<DbChapter>[]\|null> => {
294	if (!spotlight.documentId \|\| spotlight.documentType !== "Sequence") {	×
295	return null;	×
296	}
297	const chapters = await context.Chapters.find({	×
298	sequenceId: spotlight.documentId,
299	}, {
300	limit: 100,
301	sort: {number:1},
302	}).fetch();
303
304	return await accessFilterMultiple(context.currentUser, context.Chapters, chapters, context);	×
305	}
306	}),
307	"sequenceChapters.$": {
308	type: "Chapter",
309	foreignKey: "Chapters",
310	optional: true,
311	},
312	};
313
314	export default schema;	20✔

ForumMagnum / ForumMagnum / 10913046901

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous