- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 | - -1x - - - - - - - - - - - - - - - - -1x -1x -3x -2x - -3x - - - -1x -16x - - -16x - -1x -6x - - - - -1x -16x - - - - - - -1x -2x -1x -1x - -1x - - -1x -3x - -1x -1x - -1x - - - -2x - - - - - - - - - - - - - -2x -2x - -2x - - - - - - - - -2x -2x -8x - - - - - - - - - -2x - - - - - -8x - - -2x - - - -12x -2x - - - - - -10x - - - -4x -16x - - - - - - - - - -12x - -16x - - - - -2x -2x - - - - - - - | 'use strict'
-
-const OramaTypesMap = {
- string: 'string',
- text: 'string',
- email: 'string',
- richtext: 'string',
- boolean: 'boolean',
- integer: 'number',
- biginteger: 'number',
- decimal: 'number',
- float: 'number',
- uid: 'string',
- date: 'string',
- time: 'string',
- datetime: 'string',
- enumeration: 'enum'
-}
-
-const filterContentTypesAPIs = ({ contentTypes }) => {
- return Object.keys(contentTypes).reduce((sanitized, contentType) => {
- if (contentType.startsWith('api::')) {
- sanitized[contentType] = contentTypes[contentType]
- }
- return sanitized
- }, {})
-}
-
-const isValidType = (type) => {
- return !['component', 'media', 'blocks', 'json', 'password'].includes(type)
-}
-
-const isIgnoredAttribute = (attribute) => ['publishedAt', 'createdAt', 'updatedAt'].includes(attribute.name)
-
-const isValidRelation = ({ attribute, includedRelations }) => {
- return (
- attribute.target.startsWith('api::') && (includedRelations.includes(attribute.name) || includedRelations === '*')
- )
-}
-
-const shouldAttributeBeIncluded = (attribute, includedRelations) => {
- return (
- isValidType(attribute.type) &&
- !isIgnoredAttribute(attribute) &&
- (attribute.type !== 'relation' || isValidRelation({ attribute, includedRelations }))
- )
-}
-
-const getSelectedRelations = ({ schema, relations }) => {
- return relations.reduce((acc, relation) => {
- acc[relation] = {
- select: Object.keys(schema[relation]).map((key) => key)
- }
- return acc
- }, {})
-}
-const getSelectedFieldsConfigObj = (schema) =>
- Object.entries(schema).reduce((acc, [key, value]) => (typeof value === 'object' ? acc : [...acc, key]), ['id'])
-
-module.exports = ({ strapi }) => {
- return {
- getContentTypes() {
- const contentTypes = filterContentTypesAPIs({
- contentTypes: strapi.contentTypes
- })
-
- return Object.entries(contentTypes).map(([contentType, c]) => ({
- value: contentType,
- label: c.info.displayName,
- schema: this.getSchemaFromContentTypeAttributes({
- attributes: c.attributes,
- includedRelations: '*'
- }),
- availableRelations: this.getAvailableRelations({
- contentTypeId: contentType
- })
- }))
- },
-
- async getEntries({ contentType, relations = [], schema, offset = 0, limit = 50 }) {
- const selectedRelations = getSelectedRelations({ schema, relations })
- const selectedFields = getSelectedFieldsConfigObj(schema)
-
- return await strapi.query(contentType).findMany({
- populate: selectedRelations,
- select: selectedFields,
- limit,
- offset
- })
- },
-
- getAvailableRelations({ contentTypeId }) {
- const contentType = strapi.contentTypes[contentTypeId]
- const res = Object.entries(contentType.attributes).reduce((relations, [attributeName, attributeValue]) => {
- if (
- attributeValue.type === 'relation' &&
- isValidRelation({
- attribute: {
- name: attributeName,
- target: attributeValue.target
- },
- includedRelations: '*'
- })
- ) {
- relations.push({
- value: attributeName,
- label: attributeValue.target
- })
- }
-
- return relations
- }, [])
-
- return res
- },
-
- getType(attribute) {
- if (attribute.type === 'relation') {
- return this.getContentTypeSchema({
- contentTypeId: attribute.target,
- includedRelations: []
- })
- }
-
- return OramaTypesMap[attribute.type]
- },
-
- getSchemaFromContentTypeAttributes({ attributes, includedRelations }) {
- return Object.entries(attributes).reduce((schema, [attributeName, attributeValue]) => {
- if (
- shouldAttributeBeIncluded(
- {
- type: attributeValue.type,
- name: attributeName,
- target: attributeValue.target
- },
- includedRelations
- )
- ) {
- schema[attributeName] = this.getType(attributeValue)
- }
- return schema
- }, {})
- },
-
- getContentTypeSchema({ contentTypeId, includedRelations }) {
- const contentType = strapi.contentTypes[contentTypeId]
- return this.getSchemaFromContentTypeAttributes({
- attributes: contentType.attributes,
- includedRelations
- })
- }
- }
-}
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| server/services | -
-
- |
- 80.57% | -112/139 | -79.16% | -38/48 | -88.63% | -39/44 | -79.54% | -105/132 | -
| utils | -
-
- |
- 41.17% | -7/17 | -16.66% | -1/6 | -40% | -2/5 | -43.75% | -7/16 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 | - -1x - - - - - - - - - - - - - - - - -1x -1x -3x -2x - -3x - - - -1x -16x - - -16x - -1x -6x - - - - -1x -16x - - - - - - -1x -2x -1x -1x - -1x - - -1x -3x - -1x -1x - -1x - - - -2x - - - - - - - - - - - - - -2x -2x - -2x - - - - - - - - -2x -2x -8x - - - - - - - - - -2x - - - - - -8x - - -2x - - - -12x -2x - - - - - -10x - - - -4x -16x - - - - - - - - - -12x - -16x - - - - -2x -2x - - - - - - - | 'use strict'
-
-const OramaTypesMap = {
- string: 'string',
- text: 'string',
- email: 'string',
- richtext: 'string',
- boolean: 'boolean',
- integer: 'number',
- biginteger: 'number',
- decimal: 'number',
- float: 'number',
- uid: 'string',
- date: 'string',
- time: 'string',
- datetime: 'string',
- enumeration: 'enum'
-}
-
-const filterContentTypesAPIs = ({ contentTypes }) => {
- return Object.keys(contentTypes).reduce((sanitized, contentType) => {
- if (contentType.startsWith('api::')) {
- sanitized[contentType] = contentTypes[contentType]
- }
- return sanitized
- }, {})
-}
-
-const isValidType = (type) => {
- return !['component', 'media', 'blocks', 'json', 'password'].includes(type)
-}
-
-const isIgnoredAttribute = (attribute) => ['publishedAt', 'createdAt', 'updatedAt'].includes(attribute.name)
-
-const isValidRelation = ({ attribute, includedRelations }) => {
- return (
- attribute.target.startsWith('api::') && (includedRelations.includes(attribute.name) || includedRelations === '*')
- )
-}
-
-const shouldAttributeBeIncluded = (attribute, includedRelations) => {
- return (
- isValidType(attribute.type) &&
- !isIgnoredAttribute(attribute) &&
- (attribute.type !== 'relation' || isValidRelation({ attribute, includedRelations }))
- )
-}
-
-const getSelectedRelations = ({ schema, relations }) => {
- return relations.reduce((acc, relation) => {
- acc[relation] = {
- select: Object.keys(schema[relation]).map((key) => key)
- }
- return acc
- }, {})
-}
-const getSelectedFieldsConfigObj = (schema) =>
- Object.entries(schema).reduce((acc, [key, value]) => (typeof value === 'object' ? acc : [...acc, key]), ['id'])
-
-module.exports = ({ strapi }) => {
- return {
- getContentTypes() {
- const contentTypes = filterContentTypesAPIs({
- contentTypes: strapi.contentTypes
- })
-
- return Object.entries(contentTypes).map(([contentType, c]) => ({
- value: contentType,
- label: c.info.displayName,
- schema: this.getSchemaFromContentTypeAttributes({
- attributes: c.attributes,
- includedRelations: '*'
- }),
- availableRelations: this.getAvailableRelations({
- contentTypeId: contentType
- })
- }))
- },
-
- async getEntries({ contentType, relations = [], schema, offset = 0, limit = 50 }) {
- const selectedRelations = getSelectedRelations({ schema, relations })
- const selectedFields = getSelectedFieldsConfigObj(schema)
-
- return await strapi.query(contentType).findMany({
- populate: selectedRelations,
- select: selectedFields,
- limit,
- offset
- })
- },
-
- getAvailableRelations({ contentTypeId }) {
- const contentType = strapi.contentTypes[contentTypeId]
- const res = Object.entries(contentType.attributes).reduce((relations, [attributeName, attributeValue]) => {
- if (
- attributeValue.type === 'relation' &&
- isValidRelation({
- attribute: {
- name: attributeName,
- target: attributeValue.target
- },
- includedRelations: '*'
- })
- ) {
- relations.push({
- value: attributeName,
- label: attributeValue.target
- })
- }
-
- return relations
- }, [])
-
- return res
- },
-
- getType(attribute) {
- if (attribute.type === 'relation') {
- return this.getContentTypeSchema({
- contentTypeId: attribute.target,
- includedRelations: []
- })
- }
-
- return OramaTypesMap[attribute.type]
- },
-
- getSchemaFromContentTypeAttributes({ attributes, includedRelations }) {
- return Object.entries(attributes).reduce((schema, [attributeName, attributeValue]) => {
- if (
- shouldAttributeBeIncluded(
- {
- type: attributeValue.type,
- name: attributeName,
- target: attributeValue.target
- },
- includedRelations
- )
- ) {
- schema[attributeName] = this.getType(attributeValue)
- }
- return schema
- }, {})
- },
-
- getContentTypeSchema({ contentTypeId, includedRelations }) {
- const contentType = strapi.contentTypes[contentTypeId]
- return this.getSchemaFromContentTypeAttributes({
- attributes: contentType.attributes,
- includedRelations
- })
- }
- }
-}
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| content-types.js | -
-
- |
- 100% | -45/45 | -86.36% | -19/22 | -100% | -21/21 | -100% | -42/42 | -
| orama-manager.js | -
-
- |
- 71.27% | -67/94 | -73.07% | -19/26 | -78.26% | -18/23 | -70% | -63/90 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219 -220 -221 -222 -223 -224 -225 -226 -227 -228 -229 -230 -231 -232 -233 -234 -235 -236 -237 -238 -239 -240 -241 -242 -243 -244 -245 -246 -247 | - -1x -1x - - - -20x -20x -20x -20x - -20x -20x - - - - - - - -6x -1x -1x - - -5x -1x -1x - - -4x -1x - - -1x - - -3x -1x - - -1x - - -2x - - - -1x - - - - - -1x - - - - - -1x - - - - - - - -2x -2x - -2x - -2x - - - -1x -1x - - - -2x - - - - - - -2x -1x - - - - - - -1x - - -1x - - - -2x -2x - - - -2x -2x - -2x - -2x - - - -2x -2x - -2x - -2x - - - -1x -1x - -1x - -1x - - - -5x -2x - - -3x - -3x - - - -1x - -1x - - - -1x - - - - -1x - -1x - -1x - - - - -1x - -1x - -1x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -1x - - - - | "use strict"
-
-const { CloudManager } = require("@oramacloud/client")
-const { getSchemaFromAttributes } = require("../../utils/schema")
-
-class OramaManager {
- constructor({ strapi }) {
- this.strapi = strapi
- this.contentTypesService = strapi.plugin("orama-cloud").service("contentTypesService")
- this.collectionService = strapi.plugin("orama-cloud").service("collectionsService")
- this.privateApiKey = strapi.config.get("plugin.orama-cloud.privateApiKey")
-
- this.oramaCloudManager = new CloudManager({ api_key: this.privateApiKey })
- this.DocumentActionsMap = {
- create: this.oramaInsert.bind(this),
- update: this.oramaUpdate.bind(this),
- delete: this.oramaDelete.bind(this)
- }
- }
-
- validate(collection) {
- if (!collection) {
- this.strapi.log.error(`Collection not found`)
- return false
- }
-
- if (!this.privateApiKey) {
- this.strapi.log.error("Private API key is required to process index updates")
- return false
- }
-
- if (collection.status === "updating") {
- this.strapi.log.debug(
- `SKIP: Collection ${collection.entity} with indexId ${collection.indexId} is already updating`
- )
- return false
- }
-
- if (collection.status === "updated") {
- this.strapi.log.debug(
- `SKIP: Collection ${collection.entity} with indexId ${collection.indexId} is already updated`
- )
- return false
- }
-
- return true
- }
-
- async setOutdated(collection) {
- return await this.collectionService.updateWithoutHooks(collection.id, {
- status: "outdated"
- })
- }
-
- async updatingStarted(collection) {
- return await this.collectionService.updateWithoutHooks(collection.id, {
- status: "updating"
- })
- }
-
- async updatingCompleted(collection, documents_count) {
- return await this.collectionService.updateWithoutHooks(collection.id, {
- status: "updated",
- deployed_at: new Date().getTime(),
- ...(documents_count && { documents_count })
- })
- }
-
- async oramaDeployIndex({ indexId }) {
- const index = this.oramaCloudManager.index(indexId)
- const result = await index.deploy()
-
- this.strapi.log.info(`Index ${indexId} deployed`)
-
- return result
- }
-
- async resetIndex({ indexId }) {
- const index = this.oramaCloudManager.index(indexId)
- return await index.snapshot([])
- }
-
- async bulkInsert(collection, offset = 0) {
- const entries = await this.contentTypesService.getEntries({
- contentType: collection.entity,
- relations: collection.includedRelations,
- schema: collection.schema,
- offset
- })
-
- if (entries.length > 0) {
- await this.oramaInsert(
- {
- indexId: collection.indexId,
- entries
- }
- )
-
- return await this.bulkInsert(collection, offset + entries.length)
- }
-
- return { documents_count: offset }
- }
-
- async oramaUpdateSchema({ indexId, schema }) {
- const index = this.oramaCloudManager.index(indexId)
- await index.updateSchema({ schema })
- }
-
- async oramaInsert({ indexId, entries }) {
- const index = this.oramaCloudManager.index(indexId)
- const result = await index.insert(entries)
-
- this.strapi.log.info(`INSERT: documents with id ${entries.map(({ id }) => id)} into index ${indexId}`)
-
- return result
- }
-
- async oramaUpdate({ indexId, entries }) {
- const index = this.oramaCloudManager.index(indexId)
- const result = await index.update(entries)
-
- this.strapi.log.info(`UPDATE: document with id ${entries.map(({ id }) => id)} into index ${indexId}`)
-
- return result
- }
-
- async oramaDelete({ indexId, entries }) {
- const index = this.oramaCloudManager.index(indexId)
- const result = await index.delete(entries.map(({ id }) => id))
-
- this.strapi.log.info(`DELETE: document with id ${entries.map(({ id }) => id)} from index ${indexId}`)
-
- return result
- }
-
- async handleDocument({ indexId, record, action }) {
- if (!action || !record || !this.DocumentActionsMap[action]) {
- return false
- }
-
- const { createdBy, updatedBy, ...rest } = record
-
- return await this.DocumentActionsMap[action]({ indexId, entries: [{ ...rest, id: rest.id.toString() }] })
- }
-
- async populateIndex({ id }) {
- const collection = await this.collectionService.findOne(id)
-
- Iif (!this.validate(collection)) {
- return
- }
-
- const oramaSchema = getSchemaFromAttributes({
- attributes: collection.searchableAttributes,
- schema: collection.schema
- })
-
- await this.updatingStarted(collection)
-
- await this.resetIndex(collection)
-
- await this.oramaUpdateSchema({
- indexId: collection.indexId,
- schema: oramaSchema
- })
-
- const { documents_count } = await this.bulkInsert(collection)
-
- await this.oramaDeployIndex(collection)
-
- await this.updatingCompleted(collection, documents_count)
- }
-
- async afterCollectionCreationOrUpdate({ id }) {
- await this.populateIndex({ id })
- }
-
- async deployIndex({ id }) {
- const collection = await this.collectionService.findOne(id)
-
- this.strapi.log.debug(
- `Processing scheduled index update for ${collection.entity} with indexId ${collection.indexId}`
- )
-
- if (!this.validate(collection)) {
- return
- }
-
- await this.updatingStarted(collection)
-
- await this.oramaDeployIndex(collection)
-
- await this.updatingCompleted(collection)
-
- this.strapi.log.debug(`UPDATE: ${collection.entity} with indexId ${collection.indexId} completed`)
- }
-
- async processLiveUpdate({ id }, record, action) {
- const collection = await this.collectionService.findOne(id)
-
- if (!this.validate(collection)) {
- return
- }
-
- this.strapi.log.debug(`Processing live update for ${collection.entity} with indexId ${collection.indexId}`)
-
- await this.updatingStarted(collection)
-
- await this.handleDocument(
- {
- indexId: collection.indexId,
- record,
- action
- })
-
- this.strapi.log.debug(`Live update for ${collection.entity} with indexId ${collection.indexId} completed`)
- }
-
- async processScheduledUpdate({ id }) {
- const collection = await this.collectionService.findOne(id)
-
- if (!this.validate(collection)) {
- return
- }
-
- this.strapi.log.debug(
- `Processing scheduled index update for ${collection.entity} with indexId ${collection.indexId}`
- )
-
- await this.updatingStarted(collection)
-
- await this.resetIndex(collection)
-
- const { documents_count } = await this.bulkInsert(collection)
-
- await this.updatingCompleted(collection, documents_count)
-
- this.strapi.log.debug(`Scheduled update for ${collection.entity} with indexId ${collection.indexId} completed`)
- }
-}
-
-module.exports = {
- OramaManager,
- service: ({ strapi }) => new OramaManager({ strapi })
-}
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| schema.js | -
-
- |
- 41.17% | -7/17 | -16.66% | -1/6 | -40% | -2/5 | -43.75% | -7/16 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 | 1x -1x -2x - - - - - - - -2x - -2x - - - -1x - - - - - - - - - - -1x - | const getSchemaFromAttributes = ({ attributes, schema }) => {
- return attributes.reduce((acc, field) => {
- Iif (field.includes('.')) {
- const [parent, child] = field.split('.')
- if (!acc[parent]) {
- acc[parent] = {}
- }
-
- acc[parent][child] = schema[parent][child]
- } else {
- acc[field] = schema[field]
- }
- return acc
- }, {})
-}
-
-const getSelectedAttributesFromSchema = ({ schema }) => {
- return Object.entries(schema).reduce((acc, [fieldKey, fieldValue]) => {
- if (typeof fieldValue === 'object') {
- Object.keys(fieldValue).forEach((key) => acc.push(`${fieldKey}.${key}`))
- } else {
- acc.push(fieldKey)
- }
- return acc
- }, [])
-}
-
-module.exports = { getSchemaFromAttributes, getSelectedAttributesFromSchema }
- |